Skip to main content

Commits and branches

Team would be committing with the conventional commits convention

Branch naming#

Each branch should have name convention as described here

<type>/short-description-based-on-figma-task
example branch name: feature/add-menu-bar

After merging a Pull Request there You don't need to delete your source branch

Types#

Describes branch type

  • chore - update something without impacting the user (e.g. changing config in package.json)
  • feature - developing new feature
  • bugfix - fixing a bug
  • hotfix - urgent fix or collection of fixes

Conventional commits#

Projects will be using the Conventional Commits to ensure that each commit solves one problem and directly describes what changes were made.

Structure:

<type>(scope : optional): <description>
example: <Feat>(API): Add endpoint for user log in

Types#

Describes category of a change.

  • chore - update something without impacting the user (e.g. changing config in package.json)
  • feat - new feature
  • bugfix - a bug fix
  • perf - a code that is boosting performance
  • revert - reverting changes
  • test - adding tests
  • refactor - refactoring existing code which is not a bugfix nor a feature
  • build - changes done to the build config
  • CI/CD - changes to the project CI/CD configuration

Scopes (optional)#

  • core - changes in the project architecture
  • ui - changes in the UI, styling, new layout
  • deps - updating project dependencies
  • api - changes in API related code